﻿// ***************************************************************************
// YAMM
// Copyright (C) 2008 Christian Schmiljun, Frank Weißenborn
// http://www.codeplex.com/YAMM 
// 
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//
// ***************************************************************************

using System;
namespace YAMM.PlugIn
{
    /// <summary>
    /// Generic plugin interface.
    /// </summary>
    public interface IPlugin
    {
        #region Members - Information
        
        /// <summary>
        /// Gets the name of the plugin.
        /// </summary>
        /// <value>The name.</value>
        string Name { get;}

        /// <summary>
        /// Gets the GUID of the plugin.
        /// </summary>
        /// <value>The GUID.</value>
        Guid Guid { get; }

        /// <summary>
        /// Gets the version of the plugin.
        /// </summary>
        /// <value>The version.</value>
        string Version { get;}

        /// <summary>
        /// Gets the author of the plugin.
        /// </summary>
        /// <value>The author.</value>
        string Author { get;}

        /// <summary>
        /// Gets the description.
        /// </summary>
        /// <value>The description.</value>
        string Description { get; }

        /// <summary>
        /// Gets the icon of the plugin. (Resolution 32x32)
        /// </summary>        
        /// <value>The icon.</value>
        System.Drawing.Image Icon { get; }

        #endregion


        
        void Configure();
        bool IsConfigureable();
        bool CanReceive(System.Type t);
        void Receive(object o);
        void Load(IServiceProvider serviceProvider);
        void Unload();
        void Uninstall();

        event DataEventHandler Send;               
    }    
}